Sensor Data Source topic
Use this module to capture, configure, and replay device sensor streams and recorded logs with the Magic Lane Maps SDK for Flutter. It provides a cohesive set of types and services for sampling raw sensors, packaging typed sensor payloads, annotating recordings and controlling recorder and playback lifecycles for telematics, navigation, and activity-tracking use cases.
SenseData: A canonical container for a single sensor sample or aggregated payload. Use it to carry typed sensor measurements between capture, storage, and UI layers; it holds structured sensor values and metadata about the sample.- Typed sensor models (for example
Acceleration,Attitude,MagneticField,Orientation,RotationRate,Battery,Temperature,GemPosition): Strongly-typed measurement classes. Recorder: The primary service that manages capturing sensor streams into persistent logs. Use it to start, pause, and stop recordings and to coordinate sensors, camera capture according to configuration.RecorderConfiguration: Configuration object that defines how recordings are performed. Use it to specify which data types to record, storage and chunking behavior, video quality, transport mode and retention rules.Playback: Component that replays recorded logs deterministically. Use it to step through recordings, resume/pause playback, and retrieve the latest sample data for visualizations, testing or precise log playback control.LogMetadata: High-level descriptor for a recorded session. Use it to inspect start/end timestamps, data availability, transport mode, and other indexing details.LogMetrics: Aggregated numeric summary for logs. Use it to surface distance, elevation gain, and average speed in listings and analytics.SensorConfigurationandPositionSensorConfiguration: Objects that hold sampling preferences and position-specific tuning. Use these to change sensing behavior.CameraConfigurationand camera model classes: Represent camera capture settings paired with sensor streams. Use these when video needs to be synchronized and calibrated with other sensor data.RecorderBookmarks: Utility for listing, exporting, and managing saved logs on device. Use it to present recordings to users, import/export logs, and manage lifecycle operations like deletion or protection.LogUploader: Upload logs to the Magic Lane servers for bug reporting and analysisTextMark,LogMarkand related mark classes: Time-stamped annotations attached to logs. Use them to tag events, notes, or markers within recordings for later review.
The Sensor Data Source suite matters because it turns raw device sensors into reliable, reproducible recordings that power navigation, telematics, and analytics features. Its components work together to ensure sampled data is captured consistently, annotated and summarized for quick discovery, and replayed deterministically for testing and visualization. This integrated approach reduces complexity for app developers and improves accuracy and maintainability.
Prefer configuring sensing pipelines with SensorConfiguration and RecorderConfiguration before starting capture so sampling, chunking, and transport rules are deterministic. Start recordings through a single Recorder instance, attach activity metadata or marks as needed, and persist LogMetadata and LogMetrics for quick indexing. Use Playback for review and to drive UI playback controls synchronized with map visualizations.
Learn more about sensors and data sources: https://developer.magiclane.com/docs/flutter/guides/category/positioning--sensors
Classes
- Acceleration Sensor Data Source
- Acceleration sensor data in three-dimensional space.
- ActivityRecord Sensor Data Source
- Represents metadata for a recorded activity.
- Attitude Sensor Data Source
- Device orientation attitude data in 3D space.
- Battery Sensor Data Source
- Battery status information sensor data.
- Camera Sensor Data Source
- Camera frame sensor data.
- CameraConfiguration Sensor Data Source
- Camera hardware and capture settings.
- Compass Sensor Data Source
- Compass sensor data providing directional heading.
- DataSource Sensor Data Source
- Provides access to sensor and log data from various sources.
- DataSourceListener Sensor Data Source
- Receives events and sensor data from a DataSource.
- DSPrefKeys Sensor Data Source
- Keys for DataSource sensors configuration.
- DSPrefKeysPosition Sensor Data Source
- Keys for DataSource position sensors configuration.
- GemCameraPlayer Sensor Data Source
- Widget for rendering camera feed frames from a controller.
- GemCameraPlayerController Sensor Data Source
- Controller for managing camera feed playback from a data source.
- GemCameraPlayerValue Sensor Data Source
- Immutable state container for a camera player controller.
- HeartRate Sensor Data Source
- Heart rate biometric sensor data.
- LogMark Sensor Data Source
- Base interface for log marks, which can be either SoundMark or TextMark.
- LogMetadata Sensor Data Source
- Provides metadata for a recorded sensor data log.
- LogMetrics Sensor Data Source
- Provides metrics about a recorded log, such as distance, elevation gain, and average speed.
- LogUploader Sensor Data Source
- Uploads a recorded log file to Magic Lane servers for bug reports.
- MagneticField Sensor Data Source
- Magnetic field sensor data.
- Metrics Sensor Data Source
- Base Metrics interface for metric objects used by the sense library.
- MountInformation Sensor Data Source
- Device mounting information sensor data.
- NmeaChunk Sensor Data Source
- NMEA sentence data from GNSS receivers.
- Orientation Sensor Data Source
- Device orientation sensor data.
- Playback Sensor Data Source
- Controls a playback-enabled DataSource, for example a log file or a simulated route replay.
- PositionSensorConfiguration Sensor Data Source
- Configuration class for position sensor
- Recorder Sensor Data Source
- Recorder for capturing sensor and multimedia logs.
- RecorderBookmarks Sensor Data Source
- Provides access to recorded logs and their metadata on the device.
- RecorderConfiguration Sensor Data Source
- Configuration used to control recorder behavior and log storage settings.
- RecordMetrics Sensor Data Source
- Performance metrics produced while a recording is active.
- RotationRate Sensor Data Source
- Gyroscope rotation rate sensor data.
- SenseData Sensor Data Source
- Base class for all sensor data types.
- SenseDataFactory Sensor Data Source
- Factory for creating sensor data instances.
- SensorConfiguration Sensor Data Source
- Sensor configuration base class
- SoundMark Sensor Data Source
- Represents a time interval in a recording where sound was captured.
- Temperature Sensor Data Source
- Temperature sensor data.
- TextMark Sensor Data Source
- Represents a textual annotation at a specific moment in a recording.
Enums
- ActivityVisibility Sensor Data Source
- Defines visibility settings for an activity.
- BatteryHealth Sensor Data Source
- Battery health status indicators.
- BatteryState Sensor Data Source
- Battery charging and operational states.
- CompassAccuracy Sensor Data Source
- Accuracy levels for compass heading measurements.
- DataInterruptionReason Sensor Data Source
- Reasons why a data source may be interrupted.
- DataSourceType Sensor Data Source
- The data source type.
- DataType Sensor Data Source
- Known sense data types.
- EffortType Sensor Data Source
- Represents the effort level for an activity.
- FaceType Sensor Data Source
- Device face orientation types.
- FileSortOrder Sensor Data Source
- Values that represent file sorting orders.
- FileSortType Sensor Data Source
- Values that represent file sorting types.
- FileType Sensor Data Source
- Path import supported formats
- GemCameraPlayerStatus Sensor Data Source
- Playback status for a camera player controller.
- HardwareSpecification Sensor Data Source
- Enum for easily accessible hardware information on Android and iOS
- ImagePixelFormat Sensor Data Source
- Image pixel encoding formats.
- ImprovedPositionDefTransportMode Sensor Data Source
- Default transport mode for improved position
- LogUploaderState Sensor Data Source
- State of a log upload operation.
- OrientationType Sensor Data Source
- User interface orientation types.
- Origin Sensor Data Source
- Data origin.
- PlayingStatus Sensor Data Source
- Represents the playing status of a data source.
- PluggedType Sensor Data Source
- Power source connection types for a device.
- PositionAccuracy Sensor Data Source
- The position accuracy
- PositionActivity Sensor Data Source
- The position activity
- PositionQuality Sensor Data Source
- Values that represent position data quality.
- RecorderStatus Sensor Data Source
- Enumerates different states of a recorder.
- RecordingTransportMode Sensor Data Source
- Enumeration representing different modes of transportation.
- Resolution Sensor Data Source
- Estimated Video Data Rates by Resolution (used for size estimation) Values are approximate and based on platform-specific analysis:
- RoadModifier Sensor Data Source
- Current position road modifiers.
- SportType Sensor Data Source
- Sport type enumeration.
- TemperatureLevel Sensor Data Source
- Temperature severity levels.
- UnitOfMeasurementAcceleration Sensor Data Source
- Values that represent type of unit for acceleration data.